<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_09) on Sat Dec 29 12:31:15 CET 2012 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>PreviewModel (gephi 0.8.2 API)</title>
<meta name="date" content="2012-12-29">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
    if (location.href.indexOf('is-external=true') == -1) {
        parent.document.title="PreviewModel (gephi 0.8.2 API)";
    }
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!--   -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/PreviewModel.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/gephi/preview/api/PreviewController.html" title="interface in org.gephi.preview.api"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/gephi/preview/api/PreviewMouseEvent.html" title="class in org.gephi.preview.api"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/gephi/preview/api/PreviewModel.html" target="_top">Frames</a></li>
<li><a href="PreviewModel.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!--   -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.gephi.preview.api</div>
<h2 title="Interface PreviewModel" class="title">Interface PreviewModel</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="strong">PreviewModel</span></pre>
<div class="block">The Preview Model contains all items and all preview properties. <p> Items are the visual elements built from the <a href="../../../../org/gephi/graph/api/Graph.html" title="interface in org.gephi.graph.api"><code>Graph</code></a> by <a href="../../../../org/gephi/preview/spi/ItemBuilder.html" title="interface in org.gephi.preview.spi"><code>ItemBuilder</code></a> implementations and can be retrieved from this
 class. Each item has a type and default types are <a href="../../../../org/gephi/preview/api/Item.html#NODE"><code>Item.NODE</code></a>, <a href="../../../../org/gephi/preview/api/Item.html#EDGE"><code>Item.EDGE</code></a>, <a href="../../../../org/gephi/preview/api/Item.html#NODE_LABEL"><code>Item.NODE_LABEL</code></a> and <a href="../../../../org/gephi/preview/api/Item.html#EDGE_LABEL"><code>Item.EDGE_LABEL</code></a>. <p> A preview model is attached to it's workspace and
 can be retrieved from the
 <a href="../../../../org/gephi/preview/api/PreviewController.html" title="interface in org.gephi.preview.api"><code>PreviewController</code></a>.</div>
<dl><dt><span class="strong">Author:</span></dt>
  <dd>Yudi Xue, Mathieu Bastian</dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/gephi/preview/api/Item.html" title="interface in org.gephi.preview.api"><code>Item</code></a>, 
<a href="../../../../org/gephi/preview/spi/Renderer.html" title="interface in org.gephi.preview.spi"><code>Renderer</code></a></dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!--   -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/awt/Dimension.html?is-external=true" title="class or interface in java.awt">Dimension</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/preview/api/PreviewModel.html#getDimensions()">getDimensions</a></strong>()</code>
<div class="block">Returns the width and height of the graph in the graph coordinates.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/gephi/preview/spi/PreviewMouseListener.html" title="interface in org.gephi.preview.spi">PreviewMouseListener</a>[]</code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/preview/api/PreviewModel.html#getEnabledMouseListeners()">getEnabledMouseListeners</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/gephi/preview/api/Item.html" title="interface in org.gephi.preview.api">Item</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/preview/api/PreviewModel.html#getItem(java.lang.String, java.lang.Object)">getItem</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;type,
       <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;source)</code>
<div class="block">Returns the item attached to
 <code>source</code> and with the type
 <code>type</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/gephi/preview/api/Item.html" title="interface in org.gephi.preview.api">Item</a>[]</code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/preview/api/PreviewModel.html#getItems(java.lang.Object)">getItems</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;source)</code>
<div class="block">Returns all items attached to
 <code>source</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/gephi/preview/api/Item.html" title="interface in org.gephi.preview.api">Item</a>[]</code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/preview/api/PreviewModel.html#getItems(java.lang.String)">getItems</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;type)</code>
<div class="block">Returns all items with
 <code>type</code> as type.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/gephi/preview/spi/Renderer.html" title="interface in org.gephi.preview.spi">Renderer</a>[]</code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/preview/api/PreviewModel.html#getManagedEnabledRenderers()">getManagedEnabledRenderers</a></strong>()</code>
<div class="block">Returns
 <code>managedRenderers</code> Renderers that are enabled, or null if
 <code>managedRenderers</code> is null.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/gephi/preview/api/ManagedRenderer.html" title="class in org.gephi.preview.api">ManagedRenderer</a>[]</code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/preview/api/PreviewModel.html#getManagedRenderers()">getManagedRenderers</a></strong>()</code>
<div class="block">Returns currently managed renderers, or null.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/gephi/preview/api/PreviewProperties.html" title="class in org.gephi.preview.api">PreviewProperties</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/preview/api/PreviewModel.html#getProperties()">getProperties</a></strong>()</code>
<div class="block">Returns the preview properties attached to this model.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/awt/Point.html?is-external=true" title="class or interface in java.awt">Point</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/preview/api/PreviewModel.html#getTopLeftPosition()">getTopLeftPosition</a></strong>()</code>
<div class="block">Returns the top left position in the graph coordinate (i.e.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/preview/api/PreviewModel.html#setManagedRenderers(org.gephi.preview.api.ManagedRenderer[])">setManagedRenderers</a></strong>(<a href="../../../../org/gephi/preview/api/ManagedRenderer.html" title="class in org.gephi.preview.api">ManagedRenderer</a>[]&nbsp;managedRenderers)</code>
<div class="block">Sets an user-defined array of managed renderers to use when rendering.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="getProperties()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProperties</h4>
<pre><a href="../../../../org/gephi/preview/api/PreviewProperties.html" title="class in org.gephi.preview.api">PreviewProperties</a>&nbsp;getProperties()</pre>
<div class="block">Returns the preview properties attached to this model.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the preview properties</dd></dl>
</li>
</ul>
<a name="getItems(java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getItems</h4>
<pre><a href="../../../../org/gephi/preview/api/Item.html" title="interface in org.gephi.preview.api">Item</a>[]&nbsp;getItems(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;type)</pre>
<div class="block">Returns all items with
 <code>type</code> as type. <p> Default types are <a href="../../../../org/gephi/preview/api/Item.html#NODE"><code>Item.NODE</code></a>, <a href="../../../../org/gephi/preview/api/Item.html#EDGE"><code>Item.EDGE</code></a>, <a href="../../../../org/gephi/preview/api/Item.html#NODE_LABEL"><code>Item.NODE_LABEL</code></a> and <a href="../../../../org/gephi/preview/api/Item.html#EDGE_LABEL"><code>Item.EDGE_LABEL</code></a>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - the item's type</dd>
<dt><span class="strong">Returns:</span></dt><dd>all items from this type</dd></dl>
</li>
</ul>
<a name="getItems(java.lang.Object)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getItems</h4>
<pre><a href="../../../../org/gephi/preview/api/Item.html" title="interface in org.gephi.preview.api">Item</a>[]&nbsp;getItems(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;source)</pre>
<div class="block">Returns all items attached to
 <code>source</code>. <p> The source is the graph object behind the item (e.g.
 <a href="../../../../org/gephi/graph/api/Node.html" title="interface in org.gephi.graph.api"><code>Node</code></a> or <a href="../../../../org/gephi/graph/api/Edge.html" title="interface in org.gephi.graph.api"><code>Edge</code></a>). Multiple items can be created from the same source object. For instance both
 <code>Item.NODE</code> and
 <code>Item.NODE_LABEL</code> have the node object as source.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>source</code> - the item's source</dd>
<dt><span class="strong">Returns:</span></dt><dd>all items with
 <code>source</code> as source</dd></dl>
</li>
</ul>
<a name="getItem(java.lang.String, java.lang.Object)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getItem</h4>
<pre><a href="../../../../org/gephi/preview/api/Item.html" title="interface in org.gephi.preview.api">Item</a>&nbsp;getItem(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;type,
           <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;source)</pre>
<div class="block">Returns the item attached to
 <code>source</code> and with the type
 <code>type</code>. <p> The source is the graph object behind the item (e.g.
 <a href="../../../../org/gephi/graph/api/Node.html" title="interface in org.gephi.graph.api"><code>Node</code></a> or <a href="../../../../org/gephi/graph/api/Edge.html" title="interface in org.gephi.graph.api"><code>Edge</code></a>) and the type a default or a custom type. <p> Default types are <a href="../../../../org/gephi/preview/api/Item.html#NODE"><code>Item.NODE</code></a>, <a href="../../../../org/gephi/preview/api/Item.html#EDGE"><code>Item.EDGE</code></a>, <a href="../../../../org/gephi/preview/api/Item.html#NODE_LABEL"><code>Item.NODE_LABEL</code></a> and <a href="../../../../org/gephi/preview/api/Item.html#EDGE_LABEL"><code>Item.EDGE_LABEL</code></a>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - the item's type</dd><dd><code>source</code> - the item's source object</dd>
<dt><span class="strong">Returns:</span></dt><dd>the item or
 <code>null</code> if not found</dd></dl>
</li>
</ul>
<a name="getManagedRenderers()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getManagedRenderers</h4>
<pre><a href="../../../../org/gephi/preview/api/ManagedRenderer.html" title="class in org.gephi.preview.api">ManagedRenderer</a>[]&nbsp;getManagedRenderers()</pre>
<div class="block"><p>Returns currently managed renderers, or null.</p> <p>If
 <code>managedRenderers</code> is set to null, all renderers will be executed when rendering, in default implementation order.</p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>Enabled renderers or null</dd></dl>
</li>
</ul>
<a name="setManagedRenderers(org.gephi.preview.api.ManagedRenderer[])">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setManagedRenderers</h4>
<pre>void&nbsp;setManagedRenderers(<a href="../../../../org/gephi/preview/api/ManagedRenderer.html" title="class in org.gephi.preview.api">ManagedRenderer</a>[]&nbsp;managedRenderers)</pre>
<div class="block"><p>Sets an user-defined array of managed renderers to use when rendering.</p> <p><b>Only</b> the renderers marked as enabled will be executed when rendering, and <b>respecting the array
 order</b></p> <p>If the input array does not contain a managed renderer for some renderer existing implementation, a new not enabled managed renderer will be added to the end of the input
 array</p> <p>If
 <code>managedRenderers</code> is set to null, all renderers will be executed when rendering, in default implementation order.</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>managedRenderers</code> - Managed renderers for future renderings</dd></dl>
</li>
</ul>
<a name="getManagedEnabledRenderers()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getManagedEnabledRenderers</h4>
<pre><a href="../../../../org/gephi/preview/spi/Renderer.html" title="interface in org.gephi.preview.spi">Renderer</a>[]&nbsp;getManagedEnabledRenderers()</pre>
<div class="block">Returns
 <code>managedRenderers</code> Renderers that are enabled, or null if
 <code>managedRenderers</code> is null.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>Enabled renderers or null</dd></dl>
</li>
</ul>
<a name="getEnabledMouseListeners()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEnabledMouseListeners</h4>
<pre><a href="../../../../org/gephi/preview/spi/PreviewMouseListener.html" title="interface in org.gephi.preview.spi">PreviewMouseListener</a>[]&nbsp;getEnabledMouseListeners()</pre>
</li>
</ul>
<a name="getDimensions()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDimensions</h4>
<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/awt/Dimension.html?is-external=true" title="class or interface in java.awt">Dimension</a>&nbsp;getDimensions()</pre>
<div class="block">Returns the width and height of the graph in the graph coordinates.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the graph dimensions</dd></dl>
</li>
</ul>
<a name="getTopLeftPosition()">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getTopLeftPosition</h4>
<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/awt/Point.html?is-external=true" title="class or interface in java.awt">Point</a>&nbsp;getTopLeftPosition()</pre>
<div class="block">Returns the top left position in the graph coordinate (i.e. not the preview coordinates).</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the top left position point</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!--   -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/PreviewModel.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/gephi/preview/api/PreviewController.html" title="interface in org.gephi.preview.api"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/gephi/preview/api/PreviewMouseEvent.html" title="class in org.gephi.preview.api"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/gephi/preview/api/PreviewModel.html" target="_top">Frames</a></li>
<li><a href="PreviewModel.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2007-2012 <a href="http://consortium.gephi.org">Gephi Consortium</a>. All Rights Reserved.</small></p>
</body>
</html>
